{"componentChunkName":"component---node-modules-rocketseat-gatsby-theme-docs-core-src-templates-docs-query-js","path":"/code-style/RewardEthToken-RET","result":{"data":{"mdx":{"id":"6efdc177-27af-5c6c-b6a0-192b1fd2f13b","excerpt":"RET-01C: Duplicate Event Emittance & Storage Write Type Severity Location Gas Optimization Informational RewardEthToken.sol:L216 ,  L253-L259 Description: The…","fields":{"slug":"/code-style/RewardEthToken-RET/"},"frontmatter":{"title":"RewardEthToken Code Style Findings","description":"Contains all the findings that relate to code style on the contract codebase","image":null,"disableTableOfContents":null},"body":"var _excluded = [\"components\"];\n\nfunction _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }\n\nfunction _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }\n\nfunction _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }\n\n/* @jsxRuntime classic */\n\n/* @jsx mdx */\nvar _frontmatter = {\n  \"title\": \"RewardEthToken Code Style Findings\",\n  \"description\": \"Contains all the findings that relate to code style on the contract codebase\"\n};\nvar layoutProps = {\n  _frontmatter: _frontmatter\n};\nvar MDXLayout = \"wrapper\";\nreturn function MDXContent(_ref) {\n  var components = _ref.components,\n      props = _objectWithoutProperties(_ref, _excluded);\n\n  return mdx(MDXLayout, _extends({}, layoutProps, props, {\n    components: components,\n    mdxType: \"MDXLayout\"\n  }), mdx(\"h2\", {\n    \"id\": \"span-idret-01cret-01c-duplicate-event-emittance--storage-writespan\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", {\n    parentName: \"h2\",\n    \"href\": \"#span-idret-01cret-01c-duplicate-event-emittance--storage-writespan\",\n    \"aria-label\": \"span idret 01cret 01c duplicate event emittance  storage writespan permalink\",\n    \"className\": \"anchor before\"\n  }, mdx(\"svg\", {\n    parentName: \"a\",\n    \"aria-hidden\": \"true\",\n    \"focusable\": \"false\",\n    \"height\": \"16\",\n    \"version\": \"1.1\",\n    \"viewBox\": \"0 0 16 16\",\n    \"width\": \"16\"\n  }, mdx(\"path\", {\n    parentName: \"svg\",\n    \"fillRule\": \"evenodd\",\n    \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n  }))), mdx(\"span\", {\n    id: \"RET-01C\"\n  }, \"RET-01C: Duplicate Event Emittance & Storage Write\")), mdx(\"table\", null, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Severity\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Location\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"a\", {\n    parentName: \"td\",\n    \"href\": \"/stakewise-eth2-staking-implementation/appendix/finding-types#gas-optimization\"\n  }, \"Gas Optimization\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"span\", {\n    className: \"o-severity o-informational\"\n  }, \"Informational\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"a\", {\n    parentName: \"td\",\n    \"href\": \"https://github.com/stakewise/contracts/blob/2608b37dfdd47298f24d39838b5301a3ce0ecf4e/contracts/tokens/RewardEthToken.sol#L216\"\n  }, \"RewardEthToken.sol:L216\"), \", \", mdx(\"a\", {\n    parentName: \"td\",\n    \"href\": \"https://github.com/stakewise/contracts/blob/2608b37dfdd47298f24d39838b5301a3ce0ecf4e/contracts/tokens/RewardEthToken.sol#L253-L259\"\n  }, \"L253-L259\"))))), mdx(\"h3\", {\n    \"id\": \"description\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", {\n    parentName: \"h3\",\n    \"href\": \"#description\",\n    \"aria-label\": \"description permalink\",\n    \"className\": \"anchor before\"\n  }, mdx(\"svg\", {\n    parentName: \"a\",\n    \"aria-hidden\": \"true\",\n    \"focusable\": \"false\",\n    \"height\": \"16\",\n    \"version\": \"1.1\",\n    \"viewBox\": \"0 0 16 16\",\n    \"width\": \"16\"\n  }, mdx(\"path\", {\n    parentName: \"svg\",\n    \"fillRule\": \"evenodd\",\n    \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n  }))), \"Description:\"), mdx(\"p\", null, \"The \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"updateTotalRewards\"), \" function contains a logic path via which the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"RewardsUpdated\"), \" event is emitted twice with the same arguments and the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"lastUpdateBlockNumber\"), \" is written twice to the same value.\"), mdx(\"h3\", {\n    \"id\": \"example\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", {\n    parentName: \"h3\",\n    \"href\": \"#example\",\n    \"aria-label\": \"example permalink\",\n    \"className\": \"anchor before\"\n  }, mdx(\"svg\", {\n    parentName: \"a\",\n    \"aria-hidden\": \"true\",\n    \"focusable\": \"false\",\n    \"height\": \"16\",\n    \"version\": \"1.1\",\n    \"viewBox\": \"0 0 16 16\",\n    \"width\": \"16\"\n  }, mdx(\"path\", {\n    parentName: \"svg\",\n    \"fillRule\": \"evenodd\",\n    \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n  }))), \"Example:\"), mdx(\"pre\", null, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-sol\",\n    \"metastring\": \"title=contracts/tokens/RewardEthToken.sol highlight={9,10,46,47,48,49,50,51,52,53} lineNumbers=true lineOffset=206\",\n    \"title\": \"contracts/tokens/RewardEthToken.sol\",\n    \"highlight\": \"{9,10,46,47,48,49,50,51,52,53}\",\n    \"lineNumbers\": \"true\",\n    \"lineOffset\": \"206\"\n  }, \"/**\\n * @dev See {IRewardEthToken-updateTotalRewards}.\\n */\\nfunction updateTotalRewards(uint256 newTotalRewards) external override {\\n    require(msg.sender == oracles, \\\"RewardEthToken: access denied\\\");\\n\\n    uint256 periodRewards = newTotalRewards.sub(totalRewards);\\n    if (periodRewards == 0) {\\n        lastUpdateBlockNumber = block.number;\\n        emit RewardsUpdated(0, newTotalRewards, rewardPerToken, 0, 0);\\n    }\\n\\n    // calculate protocol reward and new reward per token amount\\n    uint256 protocolReward = periodRewards.mul(protocolFee).div(1e4);\\n    uint256 prevRewardPerToken = rewardPerToken;\\n    uint256 newRewardPerToken = prevRewardPerToken.add(periodRewards.sub(protocolReward).mul(1e18).div(stakedEthToken.totalDeposits()));\\n    uint128 newRewardPerToken128 = newRewardPerToken.toUint128();\\n\\n    // store previous distributor rewards for period reward calculation\\n    uint256 prevDistributorBalance = _balanceOf(address(0), prevRewardPerToken);\\n\\n    // update total rewards and new reward per token\\n    (totalRewards, rewardPerToken) = (newTotalRewards.toUint128(), newRewardPerToken128);\\n\\n    uint256 newDistributorBalance = _balanceOf(address(0), newRewardPerToken);\\n    address _protocolFeeRecipient = protocolFeeRecipient;\\n    if (_protocolFeeRecipient == address(0) && protocolReward > 0) {\\n        // add protocol reward to the merkle distributor\\n        newDistributorBalance = newDistributorBalance.add(protocolReward);\\n    } else if (protocolReward > 0) {\\n        // update fee recipient's checkpoint and add its period reward\\n        checkpoints[_protocolFeeRecipient] = Checkpoint({\\n            reward: _balanceOf(_protocolFeeRecipient, newRewardPerToken).add(protocolReward).toUint128(),\\n            rewardPerToken: newRewardPerToken128\\n        });\\n    }\\n\\n    // update distributor's checkpoint\\n    if (newDistributorBalance != prevDistributorBalance) {\\n        checkpoints[address(0)] = Checkpoint({\\n            reward: newDistributorBalance.toUint128(),\\n            rewardPerToken: newRewardPerToken128\\n        });\\n    }\\n\\n    lastUpdateBlockNumber = block.number;\\n    emit RewardsUpdated(\\n        periodRewards,\\n        newTotalRewards,\\n        newRewardPerToken,\\n        newDistributorBalance.sub(prevDistributorBalance),\\n        _protocolFeeRecipient == address(0) ? protocolReward: 0\\n    );\\n}\\n\")), mdx(\"h3\", {\n    \"id\": \"recommendation\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", {\n    parentName: \"h3\",\n    \"href\": \"#recommendation\",\n    \"aria-label\": \"recommendation permalink\",\n    \"className\": \"anchor before\"\n  }, mdx(\"svg\", {\n    parentName: \"a\",\n    \"aria-hidden\": \"true\",\n    \"focusable\": \"false\",\n    \"height\": \"16\",\n    \"version\": \"1.1\",\n    \"viewBox\": \"0 0 16 16\",\n    \"width\": \"16\"\n  }, mdx(\"path\", {\n    parentName: \"svg\",\n    \"fillRule\": \"evenodd\",\n    \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n  }))), \"Recommendation:\"), mdx(\"p\", null, \"We advise a \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"return\"), \" event to be introduced after the first emittance to ensure that the function ends early and does not waste gas executing the ensuing statements as they will be ineffectual in the case that the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"periodRewards\"), \" are zero.\"), mdx(\"h3\", {\n    \"id\": \"alleviation\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", {\n    parentName: \"h3\",\n    \"href\": \"#alleviation\",\n    \"aria-label\": \"alleviation permalink\",\n    \"className\": \"anchor before\"\n  }, mdx(\"svg\", {\n    parentName: \"a\",\n    \"aria-hidden\": \"true\",\n    \"focusable\": \"false\",\n    \"height\": \"16\",\n    \"version\": \"1.1\",\n    \"viewBox\": \"0 0 16 16\",\n    \"width\": \"16\"\n  }, mdx(\"path\", {\n    parentName: \"svg\",\n    \"fillRule\": \"evenodd\",\n    \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n  }))), \"Alleviation:\"), mdx(\"p\", null, \"A \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"return\"), \" statement was properly introduced according to our recommendation.\"), mdx(ViewDiffButton, {\n    repoUrl: \"https://github.com/stakewise/contracts\",\n    mainHash: \"2608b37dfdd47298f24d39838b5301a3ce0ecf4e\",\n    fixHash: \"63d0cccb5e238ae47831bead683e0fc72620eaaf\",\n    mdxType: \"ViewDiffButton\"\n  }));\n}\n;\nMDXContent.isMDXComponent = true;","headings":[{"depth":2,"value":"<span id=\"RET-01C\">RET-01C: Duplicate Event Emittance & Storage Write</span>"},{"depth":3,"value":"Description:"},{"depth":3,"value":"Example:"},{"depth":3,"value":"Recommendation:"},{"depth":3,"value":"Alleviation:"}]}},"pageContext":{"slug":"/code-style/RewardEthToken-RET/","prev":{"label":"PoolValidators.sol (PVS-C)","link":"/code-style/PoolValidators-PVS"},"next":{"label":"Roles.sol (ROL-C)","link":"/code-style/Roles-ROL"}}},"staticQueryHashes":["1954253342","2328931024","2501019404","973074209"]}